css: Add some docs to GtkCssLookup
authorBenjamin Otte <otte@redhat.com>
Wed, 28 Dec 2011 23:28:56 +0000 (00:28 +0100)
committerBenjamin Otte <otte@redhat.com>
Mon, 9 Jan 2012 17:37:50 +0000 (18:37 +0100)
In particular, document which parts of the CSS value querying we're
doing here.

gtk/gtkcsslookup.c

index a1e424728321f727ddfa122044069036f49ec0cb..5badd7b403befede6c2a815643066a5c73c3d010 100644 (file)
@@ -68,6 +68,16 @@ _gtk_css_lookup_is_missing (const GtkCssLookup *lookup,
   return lookup->values[id] == NULL;
 }
 
+/**
+ * _gtk_css_lookup_set:
+ * @lookup: the lookup
+ * @id: id of the property to set, see _gtk_style_property_get_id()
+ * @value: the "cascading value" to use
+ *
+ * Sets the @value for a given @id. No value may have been set for @id
+ * before. See _gtk_css_lookup_is_missing(). This function is used to
+ * set the "winning declaration" of a lookup.
+ **/
 void
 _gtk_css_lookup_set (GtkCssLookup *lookup,
                      guint         id,
@@ -81,6 +91,18 @@ _gtk_css_lookup_set (GtkCssLookup *lookup,
   lookup->values[id] = value;
 }
 
+/**
+ * _gtk_css_lookup_resolve:
+ * @lookup: the lookup
+ *
+ * Resolves the current lookup into a styleproperties object. This is done
+ * by converting from the "winning declaration" to the "computed value".
+ *
+ * XXX: This bypasses the notion of "specified value". If this ever becomes
+ * an issue, go fix it.
+ *
+ * Returns: a new #GtkStyleProperties
+ **/
 GtkStyleProperties *
 _gtk_css_lookup_resolve (GtkCssLookup *lookup)
 {